/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Nesta anotação são definidos os paineis, filtros, grids, buscas, editores e
 * transações para uma entidade.
 * 
 * @author glacuo
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface VisualEntity {

    /**
     * Definições dos grids da entidade.
     * @return
     */
    public Grid[] grids() default {};

    /**
     * Definição dos fitros da entidade.
     * @return
     */
    public Filter[] filters() default {};

    /**
     * Definição dos paineis da entidade.
     * @return
     */
    public Panel[] panels() default {};

    /**
     * Definição das busca da entidade.
     * @return
     */
    public Search[] searchs() default {};

    /**
     * Definição dos editores da entidade.
     * @return
     */
    public Editor[] editors() default {};

    /**
     * Definição das transações da entidade.
     * @return
     */
    public Transaction[] transactions() default {};

    /**
     * Lista Classes que comtém ações e eventos que serão executados por
     * transactions, editors, searchs, panels, filters, grids, e eventos
     * de validação dos campos da entidade.
     * <b>As classes utilizadas aqui deve possuir um construtor vazio, ou
     * implementarem a interface Serializable.<br>
     * Se estas classes implementarem a interface ActionMap, o filtro e o grid
     * da busca, e o painel do editor serão atribuídos ao objeto da classe.</b>
     * <br>A propria classe que contém a annotation VisualEntity não pode ser
     * um mapa de ações. Existem annotation expecíficas para ações da
     * propria classe.
     *
     * @see org.balisunrise.common.ActionMap
     * @return Um Array com classes contendo eventos e ações.
     */
    public Class[] actionMaps() default {};
}
